<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfChatSession</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinfinity-0.4 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfSession.html" title="InfSession">
<link rel="next" href="InfChatBuffer.html" title="InfChatBuffer">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfSession.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfChatBuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfChatSession.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfChatSession.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfChatSession.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfChatSession.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#InfChatSession.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#InfChatSession.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="InfChatSession">
<a name="InfChatSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfChatSession.top_of_page"></a>InfChatSession</span></h2>
<p>InfChatSession — Simple standalone chat</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="InfChatSession.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfChatSession.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libinfinity/common/inf-chat-session.h&gt;

                    <a class="link" href="InfChatSession.html#InfChatSession-struct" title="InfChatSession">InfChatSession</a>;
                    <a class="link" href="InfChatSession.html#InfChatSessionClass" title="InfChatSessionClass">InfChatSessionClass</a>;
enum                <a class="link" href="InfChatSession.html#InfChatSessionError" title="enum InfChatSessionError">InfChatSessionError</a>;
<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="returnvalue">InfChatSession</span></a> *    <a class="link" href="InfChatSession.html#inf-chat-session-new" title="inf_chat_session_new ()">inf_chat_session_new</a>                (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> backlog_size</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="type">InfSessionStatus</span></a> status</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *sync_group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *sync_connection</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfChatSession.html#inf-chat-session-set-log-file" title="inf_chat_session_set_log_file ()">inf_chat_session_set_log_file</a>       (<em class="parameter"><code><a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> *session</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *log_file</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfChatSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="InfSession.html" title="InfSession">InfSession</a>
         +----InfChatSession
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="InfChatSession.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfChatSession implements
 <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="InfChatSession.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfChatSession.html#InfChatSession--log-file" title='The "log-file" property'>log-file</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="InfChatSession.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="InfChatSession.html#InfChatSession-receive-message" title='The "receive-message" signal'>receive-message</a>"                                : Run Last
  "<a class="link" href="InfChatSession.html#InfChatSession-send-message" title='The "send-message" signal'>send-message</a>"                                   : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfChatSession.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> represents a chat session. Normally, there is one chat
session per server, and it can be enabled via <a class="link" href="InfdDirectory.html#infd-directory-enable-chat" title="infd_directory_enable_chat ()"><code class="function">infd_directory_enable_chat()</code></a>.
Clients can subscribe to the chat session via
<a class="link" href="InfcBrowser.html#infc-browser-subscribe-chat" title="infc_browser_subscribe_chat ()"><code class="function">infc_browser_subscribe_chat()</code></a>.
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfChatSession.details"></a><h2>Details</h2>
<div class="refsect2" title="InfChatSession">
<a name="InfChatSession-struct"></a><h3>InfChatSession</h3>
<pre class="programlisting">typedef struct _InfChatSession InfChatSession;</pre>
<p>
<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> is an opaque data type. You should only access it via the
public API functions.
</p>
</div>
<hr>
<div class="refsect2" title="InfChatSessionClass">
<a name="InfChatSessionClass"></a><h3>InfChatSessionClass</h3>
<pre class="programlisting">typedef struct {
  void (*receive_message)(InfChatSession* session,
                          const InfChatBufferMessage* message);
  void (*send_message)(InfChatSession* session,
                       const InfChatBufferMessage* message);
} InfChatSessionClass;
</pre>
<p>
This structure contains default signal handlers for <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfChatSessionClass.receive-message"></a>receive_message</code></em> ()</span></p></td>
<td>Default signal handler for the
<a class="link" href="InfChatSession.html#InfChatSession-receive-message" title='The "receive-message" signal'><span class="type">"receive-message"</span></a> signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfChatSessionClass.send-message"></a>send_message</code></em> ()</span></p></td>
<td>Default signal handler for the
<a class="link" href="InfChatSession.html#InfChatSession-send-message" title='The "send-message" signal'><span class="type">"send-message"</span></a> signal.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum InfChatSessionError">
<a name="InfChatSessionError"></a><h3>enum InfChatSessionError</h3>
<pre class="programlisting">typedef enum _InfChatSessionError {
  INF_CHAT_SESSION_ERROR_TYPE_INVALID,
  INF_CHAT_SESSION_ERROR_NO_SUCH_USER,

  INF_CHAT_SESSION_ERROR_FAILED
} InfChatSessionError;
</pre>
<p>
Errors that can occur with a chat session, especially in the
process_xml_sync and process_xml_run vfunc implementations.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="INF-CHAT-SESSION-ERROR-TYPE-INVALID:CAPS"></a><span class="term"><code class="literal">INF_CHAT_SESSION_ERROR_TYPE_INVALID</code></span></p></td>
<td>An invalid message type was sent.
</td>
</tr>
<tr>
<td><p><a name="INF-CHAT-SESSION-ERROR-NO-SUCH-USER:CAPS"></a><span class="term"><code class="literal">INF_CHAT_SESSION_ERROR_NO_SUCH_USER</code></span></p></td>
<td>A message referred to a nonexisting
user.
</td>
</tr>
<tr>
<td><p><a name="INF-CHAT-SESSION-ERROR-FAILED:CAPS"></a><span class="term"><code class="literal">INF_CHAT_SESSION_ERROR_FAILED</code></span></p></td>
<td>Generic error code when no further reason
of failure is known.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_chat_session_new ()">
<a name="inf-chat-session-new"></a><h3>inf_chat_session_new ()</h3>
<pre class="programlisting"><a class="link" href="InfChatSession.html" title="InfChatSession"><span class="returnvalue">InfChatSession</span></a> *    inf_chat_session_new                (<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *manager</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> backlog_size</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="type">InfSessionStatus</span></a> status</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *sync_group</code></em>,
                                                         <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *sync_connection</code></em>);</pre>
<p>
Creates a new <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> with no initial messages. The communication
manager is used to send and receive requests from subscription and
synchronization.
</p>
<p>
<em class="parameter"><code>backlog_size</code></em> specifies how much messages to save before dropping old
messages. This also limits how many old messages are transferred when
synchronizing the session.
</p>
<p>
If <em class="parameter"><code>status</code></em> is <a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a> or <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>, then the
session will initially be synchronized, meaning an initial backlog is
retrieved from <em class="parameter"><code>sync_connection</code></em> (which must not be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in this case). If
you are subscribed to the session, set the subscription group via
<a class="link" href="InfSession.html#inf-session-set-subscription-group" title="inf_session_set_subscription_group ()"><code class="function">inf_session_set_subscription_group()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>backlog_size</code></em> :</span></p></td>
<td>The number of messages to store.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td>Initial status of the session. If this is
<a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a> or <a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a>, then <em class="parameter"><code>sync_group</code></em> and
<em class="parameter"><code>sync_connection</code></em> need to be set.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sync_group</code></em> :</span></p></td>
<td>A group in which the session is synchronized. Ignored if
<em class="parameter"><code>status</code></em> is <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sync_connection</code></em> :</span></p></td>
<td>A connection to synchronize the session from. Ignored if
<em class="parameter"><code>status</code></em> is <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_chat_session_set_log_file ()">
<a name="inf-chat-session-set-log-file"></a><h3>inf_chat_session_set_log_file ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_chat_session_set_log_file       (<em class="parameter"><code><a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> *session</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *log_file</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Sets a file onto which all received messages are appended. The file is
created if it does not exist. If a previous log file was set, then it is
closed before opening the new file.
</p>
<p>
Backlog messages received upon synchronization are not logged.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>A <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>log_file</code></em> :</span></p></td>
<td>A filename to store all received messages into.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Location to store error information, if any.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the log file could be opened, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise (in which
case <em class="parameter"><code>error</code></em> is set).
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfChatSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "log-file" property'>
<a name="InfChatSession--log-file"></a><h3>The <code class="literal">"log-file"</code> property</h3>
<pre class="programlisting">  "log-file"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
<p>The file into which to store all received messages.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="InfChatSession.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "receive-message" signal'>
<a name="InfChatSession-receive-message"></a><h3>The <code class="literal">"receive-message"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>       *session,
                                                        <a class="link" href="InfChatBuffer.html#InfChatBufferMessage" title="InfChatBufferMessage"><span class="type">InfChatBufferMessage</span></a> *message,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              user_data)      : Run Last</pre>
<p>
This signal is emitted whenever a message has been received. If the
session is in <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a> state the received message was
a backlog message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>The <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> that is receiving a message.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>The <a class="link" href="InfChatBuffer.html#InfChatBufferMessage" title="InfChatBufferMessage"><span class="type">InfChatBufferMessage</span></a> that was received.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title='The "send-message" signal'>
<a name="InfChatSession-send-message"></a><h3>The <code class="literal">"send-message"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a>       *session,
                                                        <a class="link" href="InfChatBuffer.html#InfChatBufferMessage" title="InfChatBufferMessage"><span class="type">InfChatBufferMessage</span></a> *message,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              user_data)      : Run Last</pre>
<p>
This signal is emitted whenever a message is sent. Messages can be sent
by calling <a class="link" href="InfChatBuffer.html#inf-chat-buffer-add-message" title="inf_chat_buffer_add_message ()"><code class="function">inf_chat_buffer_add_message()</code></a> or
<a class="link" href="InfChatBuffer.html#inf-chat-buffer-add-emote-message" title="inf_chat_buffer_add_emote_message ()"><code class="function">inf_chat_buffer_add_emote_message()</code></a> on the session's <a class="link" href="InfChatBuffer.html" title="InfChatBuffer"><span class="type">InfChatBuffer</span></a>.
Messages of type <a class="link" href="InfChatBuffer.html#INF-CHAT-BUFFER-MESSAGE-USERJOIN:CAPS"><code class="literal">INF_CHAT_BUFFER_MESSAGE_USERJOIN</code></a> or
<a class="link" href="InfChatBuffer.html#INF-CHAT-BUFFER-MESSAGE-USERPART:CAPS"><code class="literal">INF_CHAT_BUFFER_MESSAGE_USERPART</code></a> can not be sent explicitely, so this
signal will never be emitted for such messages.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>The <a class="link" href="InfChatSession.html" title="InfChatSession"><span class="type">InfChatSession</span></a> that is sending a message.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>The <span class="type">InfChatSessionMessage</span> that is sent.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>